Cache Help.tree to disk - otherwise ~5 seconds on every single recompile is a big...
[supercollider.git] / README OS X
blob05d72a977b8aaee126d7459d624b831620ec359e
1 ------------------------------------------------------------------------
2 Introduction
3 ------------------------------------------------------------------------
5 This is the Mac OS X version of James McCartney's SuperCollider 
6 synthesis engine (scsynth) and programming language (sclang). 
7 Supercollider's main homepage is at:
9    http://supercollider.sourceforge.net/
11 To get further information on SuperCollider usage or development, you
12 should subscribe to the mailing lists:
14    http://swiki.hfbk-hamburg.de:8888/MusicTechnology/880
16 Do not use non-ASCII characters (above code point 127) in your SuperCollider program path. Doing so will break options to open class or method files automatically.
18 ------------------------------------------------------------------------
19 System Requirements
20 ------------------------------------------------------------------------
22 Mac OS X 10.4.9 or greater
23 Xcode Tools 2.4.1 or greater
25 ------------------------------------------------------------------------
26 Building
27 ------------------------------------------------------------------------
29 The easy way:
30         ./clean-compile.sh
31         ./package.sh
33 Your build will be placed in a directory named "SuperCollider".
34         
35 If you run into problems building the most likely cause is that you are
36 not running the correct version of the Xcode tools. You must be running
37 2.4.1 or above!
39 Building within Xcode:
40         There are three projects that should be BUILT IN THIS ORDER:
42         Synth
43          - the synthesis server application
45         Plugins
46          - the UGens and plugins
48         Language
49          - the OS X application with text editor, language interpreter, 
50            event scheduling etc.
52 The package.sh script does several maintenance tasks (fixing creator 
53 codes, exporting from svn, etc) and creates a ready-to-distribute zip of
54 SuperCollider.
56 ------------------------------------------------------------------------
57 On libsndfile
58 ------------------------------------------------------------------------
60 Compiling a universal binary of libsndfile requires access to both a
61 i386 and PPC Mac. The reasons for this are described here:
63 http://www.mega-nerd.com/libsndfile/FAQ.html#Q018
65 Because of this, libsndfile is included with the source as a precompiled
66 universal binary.
68 ------------------------------------------------------------------------
69 Outro
70 ------------------------------------------------------------------------
72 Thanks to James McCartney, for making this great piece of audio
73 software publicly and freely available.
75 ------------------------------------------------------------------------